home *** CD-ROM | disk | FTP | other *** search
/ The Atari Compendium / The Atari Compendium (Toad Computers) (1994).iso / files / prgtools / c / pc_shell / pc_hyp / st_guide.txt < prev   
Encoding:
Text File  |  1995-11-25  |  12.6 KB  |  449 lines
  1. tabsize: 4
  2.                                                              04.06.1995
  3.  
  4.                 ST-Guide und Pure .HLP-Dateien
  5.                 ==============================
  6.  
  7. Sowohl dem Pure C - System als auch dem Pure Profiler liegen .HLP-
  8. Dateien bei. Es liegt also Nahe, diese Dateien via ST-Guide auch für
  9. die PC-Shell zur Verfügung zu stellen. Die Dateien können jedoch nicht
  10. fertig zur Verfügung gestellt werden, da sie durch ein Copyright
  11. geschützt sind. Es steht jedoch jedem lizensierten User des Pure C -
  12. Systems frei, diese .HLP-Dateien auf eigene Gefahr und für den aus-
  13. schließlich EIGENEN Bedarf in ein anderes Format umzuwandeln.
  14.  
  15. Im folgenden wird beschrieben, wie Besitzer des Pure C - Systems und
  16. des Pure Profilers sich aus ihren .HLP-Dateien mit Hilfe der ST-Guide -
  17. Utilities .HYP-Dateien erzeugen können. Außerdem wird für Benutzer der
  18. PC-Shell, die bisher den ST-Guide noch nicht eingesetzt haben,
  19. beschrieben, aus welchen Archiven das vollständige ST-Guide-Paket
  20. besteht und wie man es installiert.
  21.  
  22.  
  23. ST-Guide und ST-Guide - Utilities
  24. =================================
  25.  
  26. Derzeit aktuell ist die Version ST-Guide V(28.04.95). Die vollständige
  27. Version (ST-Guide plus Utilities) besteht aus den folgenden 2 Archiven:
  28.  
  29.     - ST-GUI13.LZH    (188300 Bytes)
  30.       ST-Guide (ST-GUIDE.ACC, ST-GUIDE.INF, HCP.TTP, ...)
  31.       Dieses Archiv enthält den ST-Guide, ein Beispiel für die
  32.       Konfiguration (ST-GUIDE.INF), den HCP-Compiler (.STG --> .HYP),
  33.       weitere Tools (REFLINK.TTP und STOOL.TOS), sowie die Beschreibung
  34.       des ST-Guides (als Hypertext).
  35.  
  36.     - ST-G13A.LZH (27099 Bytes)
  37.       Enthält nur ST-GUIDE.ACC (Fehlerkorrektur)
  38.  
  39.     - STG-UT10.LZH    (77653 Bytes)
  40.       Enthält die ST-Guide - Utilities.
  41.       Unter anderem: HELP_RC.TTP, HELPDISC.TTP, PC_CONV.TTP.
  42.  
  43. Die 3 Archive dürften eigentlich in (fast) allen Mailboxen im MausNet
  44. vorhanden sein. Die jeweils neueste Version des ST-Guide's wird zuerst
  45. in der Maus OL (0441-9699081) abgelegt und von dort aus ins MausNet
  46. verbreitet.
  47.  
  48. Für die Extraktion der Dateien/Directories aus den Archiven wird das
  49. Programm LHARC.TTP benötigt, das in allen Mailboxen im MausNet
  50. vorhanden seien sollte.
  51.  
  52.  
  53. ST-Guide - Bezugsquellen für Leute ohne Modem
  54. =============================================
  55.  
  56. Die jeweils neueste Version kann, gegen Einsendung von DM 10.- und
  57. eines frankierten Rückumschlags, auch direkt beim Autor bezogen werden:
  58.  
  59.         Holger Weets
  60.         Tangastrasse 45
  61.         D-26121 Oldenburg
  62.  
  63.  
  64. Installation von ST-Guide
  65. =========================
  66.  
  67. Zuerst kopiert man die Archive ST-GUI13.LZH, ST-G13A.LZH und STG-UT10.LZH
  68. auf die Festplatte (Platzbedarf: ca. 400 kB + Archiv). Danach ruft man
  69. den LHARC für die Archive ST-GUI13.LZH und ST-G13A.LZH auf:
  70.  
  71.     $ LHARC.TTP x -rh ST-GUI13.LZH
  72.     $ LHARC.TTP x -rh ST-G13A.LZH
  73.  
  74. Dadurch werden im aktuellen Directory die Directories GUIDES und
  75. ST-GUIDE und die Dateien INSTALL.TXT, ST-GUIDE.ACC und ST-GUIDE.INF
  76. erzeugt.
  77.  
  78. Das weitere Vorgehen für die Installation von ST-Guide ist in der Datei
  79. INSTALL.TXT beschrieben.
  80.  
  81.  
  82. Installation der ST-Guide - Utilities
  83. =====================================
  84.  
  85. Für die ST-Guide - Utilities legt man sich am besten ein eigenes
  86. Directory, z.B. STG_UTIL, auf der Festplatte (Platzbedarf: ca. 242 kB +
  87. Archiv) an. Danach kopiert man das Archiv STG-UT10.LZH in dieses
  88. Directory und ruft den LHARC auf:
  89.  
  90.     $ LHARC.TTP x -rh STG-UT10.LZH
  91.  
  92.  
  93. Umsetzen der Pure C .HLP-Dateien in .HYP-Dateien
  94. ================================================
  95.  
  96. Die .HLP-Dateien des Pure Profilers sind nicht kompatibel zu den .HLP-
  97. Dateien des Pure C - Systems, da sie im (neueren) Format des Pure
  98. Pascal - Systems vorliegen. Der Einfachheit halber wird die Umsetzung
  99. am Beispiel der Datei C.HLP erläutert. Die angegebenen Werte gelten
  100. für die Datei C.HLP von Pure C V1.1 (Mar 20 1993) und vom Pure Profiler
  101. V1.0 (August 18 1993).
  102.  
  103.  
  104. 1. C.HLP --> C.SCR
  105. ------------------
  106.  
  107. Im 1. Schritt wird aus der .HLP-Datei eine .SCR-Datei (Source für den
  108. HELP-Compiler) erzeugt.
  109.  
  110. a.) C.HLP vom Pure C - System
  111.  
  112.     Aufruf von HELP_RC.TTP:
  113.  
  114.     $ HELP_RC.TTP S C.HLP
  115.  
  116.                 HELPFILE RECOMPILER  Ver. 1.0    Feb 01 1992
  117.                 =============================
  118.  
  119.                     (c) Volker Reichel
  120.  
  121.     Optionen: S
  122.  
  123.  
  124.         Lese sensitive Suchworttabelle...
  125.         Lese capsensitive Suchworttabelle...
  126.         Lese Screen-Tabelle...    82 Screens gefunden.
  127.         Lese String-Tabelle...
  128.         Lese Index-Screen...
  129.         Setze Namensattribute...
  130.         Bearbeite \link-Verweise...
  131.         Rekompiliere Screens...
  132.         *** WARNUNG: Globaler Verweis <dxcnv>
  133.         *** WARNUNG: Globaler Verweis <xdcnv>
  134.         *** WARNUNG: Globaler Verweis <D0>
  135.         *** WARNUNG: Globaler Verweis <D1>
  136.         *** WARNUNG: Globaler Verweis <D2>
  137.         *** WARNUNG: Globaler Verweis <A0>
  138.         *** WARNUNG: Globaler Verweis <A1>
  139.         *** WARNUNG: Globaler Verweis <ADDQ>
  140.         *** WARNUNG: Globaler Verweis <Compileroptionen>
  141.         *** WARNUNG: Globaler Verweis <exit>
  142.         *** WARNUNG: Globaler Verweis <abort>
  143.         *** WARNUNG: Globaler Verweis <abort>
  144.         *** WARNUNG: Globaler Verweis <exit>
  145.         *** WARNUNG: Globaler Verweis <exit>
  146.         *** WARNUNG: Globaler Verweis <getenv>
  147.         *** WARNUNG: Globaler Verweis <Compileroptionen>
  148.         *** WARNUNG: Globaler Verweis <getchar>
  149.         *** WARNUNG: Globaler Verweis <Compileroptionen>
  150.         *** WARNUNG: Globaler Verweis <Compileroptionen>
  151.         *** WARNUNG: Globaler Verweis <Warnungen>
  152.  
  153.     0 Fehler. 20 Warnungen. 20 Verweise in andere HELP-Dateien.
  154.     Fertig.
  155.  
  156.  
  157. b.) C.HLP vom Pure Profiler
  158.  
  159.     Aufruf von HELPDISC.TTP:
  160.  
  161.     $ HELPDISC.TTP C.HLP C.SCR
  162.  
  163.     HELPDISC Version 1.1 (Public Domain)
  164.     - Pure Pascal Helpfile Discompiler -
  165.     (v1.0 1992 by JJvB, v1.1 1994 by CZ)
  166.  
  167.     Found 71 key words.
  168.     Found 58 help pages.
  169.  
  170.     Writing ......
  171.  
  172.     Ready.
  173.  
  174.  
  175. 2. C.SCR --> C.STG
  176. ------------------
  177.  
  178. Im 2. Schritt wird aus der .SCR-Datei eine .STG-Datei (Source für den
  179. ST-Guide HCP-Compiler) erzeugt.
  180.  
  181. a.) C.HLP vom Pure C - System
  182.  
  183.     Aufruf von PC_CONV.TTP:
  184.  
  185.     $ PC_CONV.TTP -a -n C.SCR
  186.  
  187.     PC-Conv V(27.04.1994): PureC-Help --> ST-Guide sources
  188.         Written by Holger Weets using SOZOBON-C V2.00x10
  189.  
  190.  
  191.     C.SCR --> C.STG
  192.     .......
  193.     total symbols       : 80
  194.     external references: 20
  195.     total lines       : 1443
  196.  
  197.  
  198. b.) C.HLP vom Pure Profiler
  199.  
  200.     Aufruf von PC_CONV.TTP:
  201.  
  202.     $ PC_CONV.TTP -a +n C.SCR
  203.  
  204.     PC-Conv V(27.04.1994): PureC-Help --> ST-Guide sources
  205.         Written by Holger Weets using SOZOBON-C V2.00x10
  206.  
  207.  
  208.     C.SCR --> C.STG
  209.     ......
  210.     total symbols       : 128
  211.     external references: 20
  212.     total lines       : 1230
  213.  
  214.  
  215. 3. C.STG --> C.HYP
  216. ------------------
  217.  
  218. Im 3. Schritt kann nun aus der .STG-Datei eine .HYP-Datei (Hypertext
  219. für den ST-Guide) erzeugt werden.
  220.  
  221. a.) C.HLP vom Pure C - System
  222.  
  223. Bevor man die .HYP-Datei erzeugt, sollte man noch einige Korrekturen an
  224. der erzeugten .STG-Datei vornehmen:
  225.  
  226.     1. Am Dateianfang sind die folgenden Zeilen einzufügen:
  227.     
  228.         @database "Pure C V1.1 - C Language"
  229.         @subject "Dokumentation/Shells/Pure C V1.1 - C Language"
  230.         @author "anonymous"
  231.         @$VER: c.hyp 1.00 (07/01/95)
  232.         @help Hilfe
  233.         @options -a -s +z
  234.         @toc Main
  235.  
  236.     2. @options -sa
  237.        Löschen
  238.  
  239.     3. @node "Help"
  240.        ersetzen durch @node "Copyright" und verschieben nach
  241.        @node "C Language" ... @endnode
  242.  
  243.     4. @node Main ... @endnode
  244.        Löschen
  245.  
  246.     5. @node "C Language"
  247.        Ersetzen durch die beiden Zeilen:
  248.  
  249.         @node Main "C Language"
  250.         @symbol air "C Language"
  251.  
  252.       Nach @endnode von @node "C Language" kann die folgende Seite
  253.       eingefügt werden. Soll diese Seite nicht eingefügt werden, so ist
  254.       die Anweisung "@help Hilfe" oben zu streichen.
  255.  
  256.         @node "Hilfe"
  257.  
  258.             Diese Online-Hilfe wurde aus der Datei C.HLP des Pure C V1.1 -
  259.             Systems erzeugt.
  260.  
  261.         @endnode
  262.  
  263.     6. @node "ASCII-Tabelle" ... @endnode
  264.        Eine Zeile in der ASCII-Tabelle ist verschoben. Korrigiert sieht sie
  265.        folgendermaßen aus:
  266.  
  267.             10    A    12   00001010  <LF>  | 138   8A   212   10001010   è
  268.  
  269.     7. @node "%%GLOBAL%%" ... @endnode
  270.        Alle externen Referenzen enthalten einen LINK auf diese Seite.
  271.        Hat man die anderen .HLP-Dateien (LIB.HLP,PASM.HLP,PC.HLP) auch
  272.        konvertiert, so kann man diese LINKs durch die korrekten Verweise
  273.        ersetzen.
  274.  
  275.        Beispiel:
  276.  
  277.        In C.STG gibt es den Verweis
  278.  
  279.             @{"abort" link "%%GLOBAL%%"}
  280.  
  281.        In der Datei LIB.HLP gibt es die Seite "abort" und die Datei
  282.        LIB.HLP wurde in PC_LIB.HYP konvertiert. Der neue Verweis hat
  283.        sieht dann folgendermaßen aus:
  284.  
  285.             @{"abort" link "lib.hyp/abort"}
  286.  
  287.  
  288. Nach diesen Änderungen kann man die .HYP-Datei erzeugen:
  289.  
  290.     $ HCP.TTP -a -s +z -oC.HYP C.STG
  291.  
  292.     hcp V(12.10.1994): Hypertext compiler
  293.         by H. Weets & C. Wempe using SOZOBON-C V2.00x10
  294.  
  295.     compiling C.STG to C.HYP
  296.     pass 1: Index
  297.     pass 2: Index
  298.     Writing reference-file
  299.     internal nodes: 62
  300.     external nodes: 10
  301.     images          : 0
  302.     other nodes   : 0
  303.     compression   : 22301 bytes
  304.  
  305.  
  306. b.) C.HLP vom Pure Profiler
  307.  
  308. Bevor man die .HYP-Datei erzeugt, sollte man noch einige Korrekturen an
  309. der erzeugten .STG-Datei vornehmen:
  310.  
  311.     1. Am Dateianfang sind die folgenden Zeilen einzufügen:
  312.     
  313.         @database "Pure C V1.1 - C Language"
  314.         @subject "Dokumentation/Shells/Pure C V1.1 - C Language"
  315.         @author "anonymous"
  316.         @$VER: c.hyp 1.00 (07/01/95)
  317.         @help Hilfe
  318.         @options -a -n -s +z
  319.         @toc page0
  320.  
  321.     2. @options -san
  322.        Löschen
  323.  
  324.     3. @node Main ... @endnode
  325.        Löschen
  326.  
  327.     4. @node "page0" "C Language"
  328.        Ersetzen durch die beiden Zeilen:
  329.  
  330.         @node "page0" "C Language"
  331.         @symbol air Main
  332.  
  333.       Nach @endnode von @node "C Language" kann die folgende Seite
  334.       eingefügt werden. Soll diese Seite nicht eingefügt werden, so ist
  335.       die Anweisung "@help Hilfe" oben zu streichen.
  336.  
  337.         @node "Hilfe" "Hilfe"
  338.  
  339.             Diese Online-Hilfe wurde aus der Datei C.HLP des
  340.             Pure Profiler V1.0 erzeugt.
  341.  
  342.         @endnode
  343.  
  344.     5. @node "page57" "ASCII-Tabelle"
  345.        Fehlt !!
  346.  
  347.     6. @node "page-1%%" ... @endnode
  348.        Alle externen Referenzen enthalten einen LINK auf diese Seite.
  349.        Hat man die anderen .HLP-Dateien (LIB.HLP,PASM.HLP,PC.HLP) auch
  350.        konvertiert, so kann man diese LINKs durch die korrekten Verweise
  351.        ersetzen.
  352.  
  353.        Beispiel:
  354.  
  355.        In C.STG gibt es den Verweis
  356.  
  357.             @{"abort" link "page-1"}
  358.  
  359.        In der Datei LIB.HLP gibt es die Seite "abort" und die Datei
  360.        LIB.HLP wurde in PC_LIB.HYP konvertiert. Der neue Verweis hat
  361.        sieht dann folgendermaßen aus:
  362.  
  363.             @{"abort" link "lib.hyp/abort"}
  364.  
  365.  
  366. Nach diesen Änderungen kann man die .HYP-Datei erzeugen:
  367.  
  368.     $ HCP.TTP -a -n -s +z -oC.HYP C.STG
  369.  
  370.     hcp V(12.10.1994): Hypertext compiler
  371.         by H. Weets & C. Wempe using SOZOBON-C V2.00x10
  372.  
  373.     compiling C.STG to C.HYP
  374.     pass 1: Index
  375.     pass 2: page21
  376.     warning: C.STG, line 459: link to current node
  377.     pass 2: Index
  378.     Writing reference-file
  379.     internal nodes: 60
  380.     external nodes: 24
  381.     images          : 0
  382.     other nodes   : 0
  383.     compression   : 16645 bytes
  384.  
  385.  
  386. Bei der Datei PASM.HLP kann ähnlich vorgegangen werden.
  387.  
  388.  
  389. Konvertierung von LIB.HLP
  390. =========================
  391.  
  392. Bei der Konvertierung von LIB.HLP sind nach der Erzeugung der Datei
  393. LIB.STG noch einige Besonderheiten zu beachten:
  394.  
  395.     - Node "Libraries"
  396.       Dieser Node sollte als 1. Node in der Datei LIB.STG stehen, damit
  397.       er als Einstieg in den Hypertext angezeigt wird.
  398.  
  399. Die weiteren Hinweise gelten für die LIB.STG-Datei, die aus der LIB.HLP-
  400. Datei des Pure C V1.1 - Systems erzeugt wurde. Wegen der Größe der Datei
  401. Lib.STG (> 900 kB) wurde nur die Datei aus dem Pure C V1.1 - System
  402. konvertiert.
  403.  
  404.     - Node "__NFPUIN__"
  405.       Für die Funktionen
  406.  
  407.           - fetoxm1
  408.           - fgetman
  409.           - fgetexp
  410.           - fint
  411.           - fintrz
  412.           - flognp1
  413.           - frem
  414.           - fsgldiv
  415.           - fsglmul
  416.  
  417.       fehlen Nodes in der Datei LIB.STG (Pure C V1.1 - System, Pure
  418.       Profiler nicht ausprobiert). Diese Funktionen sind FPU-Befehle,
  419.       die in PASM.STG beschrieben sind. Man kann z.B. ersetzen
  420.  
  421.         @{"fetoxm1" link "fetoxm1"}
  422.  
  423.       durch
  424.  
  425.         @{"fetoxm1" link "pasm.hyp/FETOXM1"}
  426.  
  427.     - LINK - Probleme bei HCP V(12.10.1994)
  428.       Wird in einem LINK auf ein @symbol und nicht auf ein @node
  429.       verwiesen, so werden falsche Verweise erzeugt.
  430.  
  431.       Beispiel: BCONMAP, Bconmap
  432.  
  433.       Die Funktion Bconmap() liefert unter anderem einen Pointer auf
  434.       eine Struktur vom Typ BCONMAP zurück. Die Beschreibung der
  435.       Funktion enthält deshalb einen Verweis auf BCONMAP:
  436.  
  437.         @{"BCONMAP" link "BCONMAP"}
  438.  
  439.       In der Datei LIB.STG ist "BCONMAP" jedoch ein @symbol und nicht
  440.       ein @node, obwohl auf der Seite die Struktur BCONMAP beschrieben
  441.       wird. In der Datei LIB.HYP steht dann statt des Verweises BCONMAP
  442.       der Verweis Bconmap, der auf sich selbst (die selbe Seite)
  443.       verweist. Ändert man für die Seite BCONMAP die Zuordnung so, daß
  444.       BCONMAP der @node ist, erzeugt der HCP den richtigen Verweis.
  445.  
  446.       Solche Verweisprobleme erkennt man daran, daß der HCP im Pass 2
  447.       meldet, daß ein Verweis (@{"..." link "..."}) auf sich selbst
  448.       (d.h. den aktuellen @node) verweist.
  449.